Eclipse Platform
Pre-release 3.0

org.eclipse.jface.action
Class ActionContributionItem

java.lang.Object
  extended byorg.eclipse.jface.action.ContributionItem
      extended byorg.eclipse.jface.action.ActionContributionItem
All Implemented Interfaces:
IContributionItem

public class ActionContributionItem
extends ContributionItem

A contribution item which delegates to an action.

This class may be instantiated; it is not intended to be subclassed.


Constructor Summary
ActionContributionItem(IAction action)
          Creates a new contribution item from the given action.
 
Method Summary
 boolean equals(Object o)
          Compares this action contribution item with another object.
 void fill(Composite parent)
          The ActionContributionItem implementation of this IContributionItem method creates an SWT Button for the action using the action's style.
 void fill(Menu parent, int index)
          The ActionContributionItem implementation of this IContributionItem method creates an SWT MenuItem for the action using the action's style.
 void fill(ToolBar parent, int index)
          The ActionContributionItem implementation of this , IContributionItem method creates an SWT ToolItem for the action using the action's style.
 IAction getAction()
          Returns the action associated with this contribution item.
static boolean getUseColorIconsInToolbars()
          Returns whether color icons should be used in toolbars.
 int hashCode()
           
 boolean isDynamic()
          The action item implementation of this IContributionItem method returns true for menu items and false for everything else.
 boolean isEnabled()
          The default implementation of this IContributionItem method returns true.
protected  boolean isEnabledAllowed()
          Returns true if this item is allowed to enable, false otherwise.
 boolean isVisible()
          The ActionContributionItem implementation of this ContributionItem method extends the super implementation by also checking whether the command corresponding to this action is active.
static void setUseColorIconsInToolbars(boolean useColorIcons)
          Sets whether color icons should be used in toolbars.
 void update()
          The action item implementation of this IContributionItem method calls update(null).
 void update(String propertyName)
          Synchronizes the UI with the given property.
 
Methods inherited from class org.eclipse.jface.action.ContributionItem
dispose, fill, getId, getParent, isDirty, isGroupMarker, isSeparator, saveWidgetState, setParent, setVisible, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ActionContributionItem

public ActionContributionItem(IAction action)
Creates a new contribution item from the given action. The id of the action is used as the id of the item.

Parameters:
action - the action
Method Detail

getUseColorIconsInToolbars

public static boolean getUseColorIconsInToolbars()
Returns whether color icons should be used in toolbars.

Returns:
true if color icons should be used in toolbars, false otherwise

setUseColorIconsInToolbars

public static void setUseColorIconsInToolbars(boolean useColorIcons)
Sets whether color icons should be used in toolbars.

Parameters:
useColorIcons - true if color icons should be used in toolbars, false otherwise

equals

public boolean equals(Object o)
Compares this action contribution item with another object. Two action contribution items are equal if they refer to the identical Action.


fill

public void fill(Composite parent)
The ActionContributionItem implementation of this IContributionItem method creates an SWT Button for the action using the action's style. If the action's checked property has been set, the button is created and primed to the value of the checked property.

Specified by:
fill in interface IContributionItem
Overrides:
fill in class ContributionItem

fill

public void fill(Menu parent,
                 int index)
The ActionContributionItem implementation of this IContributionItem method creates an SWT MenuItem for the action using the action's style. If the action's checked property has been set, a button is created and primed to the value of the checked property. If the action's menu creator property has been set, a cascading submenu is created.

Specified by:
fill in interface IContributionItem
Overrides:
fill in class ContributionItem

fill

public void fill(ToolBar parent,
                 int index)
The ActionContributionItem implementation of this , IContributionItem method creates an SWT ToolItem for the action using the action's style. If the action's checked property has been set, a button is created and primed to the value of the checked property. If the action's menu creator property has been set, a drop-down tool item is created.

Specified by:
fill in interface IContributionItem
Overrides:
fill in class ContributionItem

getAction

public IAction getAction()
Returns the action associated with this contribution item.

Returns:
the action

hashCode

public int hashCode()

isDynamic

public boolean isDynamic()
The action item implementation of this IContributionItem method returns true for menu items and false for everything else.

Specified by:
isDynamic in interface IContributionItem
Overrides:
isDynamic in class ContributionItem

isEnabled

public boolean isEnabled()
Description copied from class: ContributionItem
The default implementation of this IContributionItem method returns true. Subclasses may override.

Specified by:
isEnabled in interface IContributionItem
Overrides:
isEnabled in class ContributionItem

isEnabledAllowed

protected boolean isEnabledAllowed()
Returns true if this item is allowed to enable, false otherwise.

Returns:
if this item is allowed to be enabled
Since:
2.0

isVisible

public boolean isVisible()
The ActionContributionItem implementation of this ContributionItem method extends the super implementation by also checking whether the command corresponding to this action is active.

Specified by:
isVisible in interface IContributionItem
Overrides:
isVisible in class ContributionItem

update

public final void update()
The action item implementation of this IContributionItem method calls update(null).

Specified by:
update in interface IContributionItem
Overrides:
update in class ContributionItem

update

public void update(String propertyName)
Synchronizes the UI with the given property.

Specified by:
update in interface IContributionItem
Overrides:
update in class ContributionItem
Parameters:
propertyName - the name of the property, or null meaning all applicable properties

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.